-
Notifications
You must be signed in to change notification settings - Fork 8
docs: exchange integrations cheat sheet #118
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Brendan Graetz <[email protected]>
WalkthroughTwo documentation files were updated to provide guidance on exchange integrations with Injective. The Table of Contents was updated with a new entry, and a comprehensive guidance document was added explaining MultiVM architecture, token types (fungible tokens and NFTs), transaction handling, and operational rules for exchanges. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Nitpick comments (1)
.gitbook/developers-evm/exchange-integrations-cheat-sheet-evm.md (1)
54-60: Improve parallel structure in Deposits section for readability.Lines 56 and 59 describe similar conditions but use inconsistent wording. Line 56 says "If user deposits using a Cosmos address" while line 59 says "If user enters an EVM address". For consistency and clarity, line 59 should use parallel language.
Apply this diff:
- If user enters an EVM address (`0x...`): + If user deposits using an EVM address (`0x...`):
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.gitbook/SUMMARY.md(1 hunks).gitbook/developers-evm/exchange-integrations-cheat-sheet-evm.md(1 hunks)
| # Exchange Integrations Cheatsheet | ||
|
|
||
| If you are an exchange (either CEX or DEX), itegrating with Injective Mainnet, this page is for you! | ||
|
|
||
| ## Injective's MultiVM architecture | ||
|
|
||
| Injective supports **both** Cosmos and EVM transactions. | ||
| There are, therefore two different ways to perform several operations. | ||
| As an exchange, most likely you are primarily concerned about how this impacts the following activity: | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo in introduction.
Line 3 has a spelling error.
Apply this diff:
- If you are an exchange (either CEX or DEX), itegrating with Injective Mainnet, this page is for you!
+ If you are an exchange (either CEX or DEX), integrating with Injective Mainnet, this page is for you!📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Exchange Integrations Cheatsheet | |
| If you are an exchange (either CEX or DEX), itegrating with Injective Mainnet, this page is for you! | |
| ## Injective's MultiVM architecture | |
| Injective supports **both** Cosmos and EVM transactions. | |
| There are, therefore two different ways to perform several operations. | |
| As an exchange, most likely you are primarily concerned about how this impacts the following activity: | |
| # Exchange Integrations Cheatsheet | |
| If you are an exchange (either CEX or DEX), integrating with Injective Mainnet, this page is for you! | |
| ## Injective's MultiVM architecture | |
| Injective supports **both** Cosmos and EVM transactions. | |
| There are, therefore two different ways to perform several operations. | |
| As an exchange, most likely you are primarily concerned about how this impacts the following activity: | |
🤖 Prompt for AI Agents
.gitbook/developers-evm/exchange-integrations-cheat-sheet-evm.md lines 1-10: fix
the spelling mistake in the introduction by replacing "itegrating" with
"integrating" so the sentence reads "If you are an exchange (either CEX or DEX),
integrating with Injective Mainnet, this page is for you!".
| ## Cosmos and EVM transactions | ||
|
|
||
| When can you use Cosmos transactions? | ||
| When can you use EVM transactions? | ||
| The answer varies depending on the asset that is being transferred. | ||
|
|
||
| When transferring INJ, the cryptocurrency of the Injective network: | ||
|
|
||
| - All all cases, you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | ||
|
|
||
| When transferring fungible tokens, you must first check what type of fungible token it is: | ||
|
|
||
| - If it implements the [MultiVM Token Standard (MTS)](./multivm-token-standard.md), | ||
| you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | ||
| - This is because MTS tokens are simultaneously both a Denom and an ERC20. | ||
| - If it is a Denom (and not MTS), you may only use Cosmos transactions. | ||
| - If it is an ERC20 (and not MTS), you may only use EVM transactions. | ||
|
|
||
| When transferring non-fungible tokens: | ||
|
|
||
| - If it is a Cosmos NFT (`x/nft`), you may only use Cosmos transactions. | ||
| - If it is an ERC721, you may only use EVM transactions. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammar error: duplicate word.
Line 23 repeats "all" — this should read "In all cases" instead of "All all cases".
Apply this diff:
- - All all cases, you may use **either** Cosmos transactions or EVM transactions, they are equivalent.
+ - In all cases, you may use **either** Cosmos transactions or EVM transactions, they are equivalent.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Cosmos and EVM transactions | |
| When can you use Cosmos transactions? | |
| When can you use EVM transactions? | |
| The answer varies depending on the asset that is being transferred. | |
| When transferring INJ, the cryptocurrency of the Injective network: | |
| - All all cases, you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | |
| When transferring fungible tokens, you must first check what type of fungible token it is: | |
| - If it implements the [MultiVM Token Standard (MTS)](./multivm-token-standard.md), | |
| you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | |
| - This is because MTS tokens are simultaneously both a Denom and an ERC20. | |
| - If it is a Denom (and not MTS), you may only use Cosmos transactions. | |
| - If it is an ERC20 (and not MTS), you may only use EVM transactions. | |
| When transferring non-fungible tokens: | |
| - If it is a Cosmos NFT (`x/nft`), you may only use Cosmos transactions. | |
| - If it is an ERC721, you may only use EVM transactions. | |
| ## Cosmos and EVM transactions | |
| When can you use Cosmos transactions? | |
| When can you use EVM transactions? | |
| The answer varies depending on the asset that is being transferred. | |
| When transferring INJ, the cryptocurrency of the Injective network: | |
| - In all cases, you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | |
| When transferring fungible tokens, you must first check what type of fungible token it is: | |
| - If it implements the [MultiVM Token Standard (MTS)](./multivm-token-standard.md), | |
| you may use **either** Cosmos transactions or EVM transactions, they are equivalent. | |
| - This is because MTS tokens are simultaneously both a Denom and an ERC20. | |
| - If it is a Denom (and not MTS), you may only use Cosmos transactions. | |
| - If it is an ERC20 (and not MTS), you may only use EVM transactions. | |
| When transferring non-fungible tokens: | |
| - If it is a Cosmos NFT (`x/nft`), you may only use Cosmos transactions. | |
| - If it is an ERC721, you may only use EVM transactions. |
🤖 Prompt for AI Agents
.gitbook/developers-evm/exchange-integrations-cheat-sheet-evm.md around lines 15
to 37: fix the duplicated word in the INJ transfer section by replacing the
phrase "All all cases, you may use **either** Cosmos transactions or EVM
transactions, they are equivalent." with the corrected phrasing "In all cases,
you may use **either** Cosmos transactions or EVM transactions, they are
equivalent."
| * [The Graph](https://docs.substreams.dev/documentation/how-to-guides/injective) | ||
| * [EVM Developers](developers-evm/README.md) | ||
| * [EVM Network Information](developers-evm/network-information.md) | ||
| * [Exchange Integrations Cheatsheet](developers-evm/exchgange-integrations-cheat-sheet-evm.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix broken documentation link: filename mismatch in path.
The path references exchgange-integrations-cheat-sheet-evm.md (misspelled) but the actual file is named exchange-integrations-cheat-sheet-evm.md. This will result in a broken link in the documentation.
Apply this diff to correct the path:
- * [Exchange Integrations Cheatsheet](developers-evm/exchgange-integrations-cheat-sheet-evm.md)
+ * [Exchange Integrations Cheatsheet](developers-evm/exchange-integrations-cheat-sheet-evm.md)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * [Exchange Integrations Cheatsheet](developers-evm/exchgange-integrations-cheat-sheet-evm.md) | |
| * [Exchange Integrations Cheatsheet](developers-evm/exchange-integrations-cheat-sheet-evm.md) |
🤖 Prompt for AI Agents
In .gitbook/SUMMARY.md around line 138 the link path contains a typo
"exchgange-integrations-cheat-sheet-evm.md" which doesn't match the actual file
name; update that entry to the correct filename
"exchange-integrations-cheat-sheet-evm.md" so the link points to the existing
document (ensure only the filename is changed and spacing/markdown list
formatting is preserved).
Summary by CodeRabbit